Execute Process from Custom Extension (Custom Operators)

Synopsis

This Operator can execute processes stored in the custom extension. The process to retrieve here must have been stored in the custom extension via the Repository folder in Extension > Create Custom Extension.

Description

This operator can be used to embed a complete process definition of a saved process into the current process definition. The saved process will be loaded and executed when the current process reaches this operator. Optionally, the input of this operator can be used as input for the embedded process. In both cases, the output of the saved process will be delivered as output of this operator. Please note that validation checks will not work for a process containing an operator of this type since the check cannot be performed without actually loading the process.

Differentiation

This Operator is like the Execute Process Operators in the Utility group but for a process that has been stored in a custom extension.

Input

input
The Execute Process from Custom Extension operator can have multiple inputs. When one input port is connected, another inputport becomes available which is ready to accept another input (if any). The order of inputs remains the same. The object supplied at the first input port of the Execute Process from Custom Extension operator is available at the first input port of the embedded process. Don't forget to connect all inputs in correct order. Make sure that you have connected the right number of ports.

Output

result
The Execute Process from Custom Extension operator can have multiple outputs. When one result port is connected, another result port becomes available which is ready to deliver another output (if any). The order of outputs remains the same. The Object delivered at the first output port of the embedded process is delivered at the first result port of the Execute Process from Custom Extension operator. Don't forget to connect all outputs in correct order. Make sure that you have connected the right number of ports.

Parameters

extension_name The name of the custom extension from which to retrieve the object. Range:
process_name The name of the RapidMiner Process which should be loaded. It must have been stored previously in the custom extension. Range:
use_inputThis is an expert parameter. It indicates if the input of this operator should be used as input for the embedded process. This should always be set to true if you want to provide input to the embedded process through the current process. Range: boolean
store_outputThis is an expert parameter. It indicates if the operator output should be stored. This applies only if the context of the embedded process defines output locations. Range: boolean
propagate_metadata_recursivelyThis is an expert parameter. It determines whether meta data is propagated through the included process. Range: boolean
cache_processThis is an expert parameter. It determines if the process should be loaded during execution. If it is checked, the process will not be loaded during the execution. Range: boolean
macrosThis is an expert parameter. It defines macros for this sub-process. Range:
fail_for_unknown_macrosThis is an expert parameter. It decides which macros you can define at the 'macros' list above. If checked, only macros defined in the embedded process' context can be defined in the 'macros' list above. Range:

Categories

Versions